RemoveSystemNotification

RemoveSystemNotification(tag)

Cancels a previously registered System Notification created using the AddSystemNotification Method.

All

tag - required

The name of the notification you want to cancel.

The name is the tag you specified in the original call to AddSystemNotification to create this notification.

Failure.

Success.

• This Method can be used to cancel an alert/reminder previously set up using the AddSystemNotification Method.

• On the Windows Desktop Platform, closing the Digitise Apps Client will automatically cancel any outstanding notifications – the Client must be running in order for notifications to persist and operate. If you want to cancel a notification whilst the Client is running, you can use RemoveSystemNotification.

• On other Platforms, if you don't cancel a notification and the Digitise app which registered the notification is uninstalled, when the notification occurs or the next time it repeats, a message will be displayed within the Digitise Apps Client explaining that the app can't be found and the notification will be cancelled. Re-installing the app later may automatically restart the notifications.

• If you don't know the tag used to create this notification, you can access it in the OnSystemNotification Event, which is triggered when you acknowledge a notification. When this Event is triggered, the notification tag is passed to the Event's Script and stored in a variable called Tag. Within the OnSystemNotification Event's Script you could, for example, use MsgBox(Tag) to display the tag or simply use RemoveSystemNotification(Tag) to delete the notification. The OnSystemNotification Event can be accessed via the Project Properties in App Studio.